创建 Coupon Template 对象

调用该接口创建一个 coupon_template 对象。优惠券模板不能直接使用,需要根据模板在用户下创建优惠券后在订单中使用。

请求参数描述
APP_ID required string对应 app 对象的 id,该参数仅需要填写在请求地址内,查看 如何获取App ID
type required int优惠券模板的类型。取值包括 "1":现金券、"2":折扣券。
name optional string优惠券模板名称,1~64 位。
amount_off conditional int折扣金额,在 type 为 1 时必传,取值范围 1~1000000000。
percent_off conditional int折扣百分比,在 type 为 2 时必传。例如值为 "20" 表示 8 折,值为 "100" 表示免费。
amount_available optional int订单金额大于等于该值时,优惠券有效(用于设置满减券)。取值范围 0~1000000000。默认值为 "0",表示无限制。
discount_amount_limit optional,int折扣上限,仅在 type 为 2 时生效。比如折扣上限为 20 元,当使用 8 折优惠券,订单金额为 200 元时,最高只可折扣 20 元,而非 40 元。
max_circulation optional int优惠券最大生成数量,当已生成数量达到最大值时,不能再生成优惠券;取值范围为 1 - 1000000。不填时默认为 null,表示可以无限生成。
max_user_circulation optional int单个用户优惠券最大生成数量,当已生成数量达到最大值时,不能再生成优惠券,删除优惠券不会影响该值;取值范围为 1 - 100,默认值为 1。
metadata optional hash详见 元数据
expiration optional hash通过该优惠券模板创建的优惠券有效期规则,详细请参考下方 expiration 参数说明
refundable optional bool订单全额退款时是否退还优惠券。默认值为 true
expiration描述
time_start optional string优惠券可用的开始时间,用 Unix 时间戳表示。
time_end optional string优惠券可用的结束时间,用 Unix 时间戳表示。
duration optional int优惠券创建后的过期时间,单位为秒。不能和 time_starttime_end 同时使用。

返回

返回一个 coupon_template 对象,或者返回一个错误,详见 错误

定义

POST https://api.pingxx.com/v1/apps/{APP_ID}/coupon_templates
待补充
待补充
待补充
待补充
待补充
待补充
待补充

请求示例

curl https://api.pingxx.com/v1/apps/{APP_ID}/coupon_templates \
-H "Pingplusplus-Request-Timestamp: 1475029155" \
-H "Pingplusplus-Signature: SIGNATURE" \
-u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC:
-d '{
    "name": "25OFF",
    "type": 1,
    "percent_off": 25,
    "amount_available": 10000,
    "max_circulation": 1000,
    "metadata": {
    },
    "expiration": null
}'
待补充
待补充
待补充
待补充
待补充
待补充
待补充

返回示例

{
    "id": "300116082415452100000700",
    "object": "coupon_template",
    "app": "APP_ID",
    "amount_available": 10000,
    "amount_off": 25,
    "created": 1470904889,
    "expiration": null,
    "livemode": false,
    "max_circulation": 1000,
    "max_user_circulation":1,
    "metadata": {
    },
    "name": "25OFF",
    "percent_off": null,
    "refundable": true,
    "times_circulated": 0,
    "times_redeemed": 0,
    "type": 1
}